Configure docstub and add type hints for forest_plot#429
Open
PiyushPanwarFST wants to merge 1 commit intoarviz-devs:mainfrom
Open
Configure docstub and add type hints for forest_plot#429PiyushPanwarFST wants to merge 1 commit intoarviz-devs:mainfrom
PiyushPanwarFST wants to merge 1 commit intoarviz-devs:mainfrom
Conversation
* Add docstub.toml for type mappings * Fix smart quotes in docstrings * Update ci_probs from (float, float) to array-like of shape (2,) * Add generated forest_plot.pyi file Signed-off-by: PiyushPanwarFST <piyush2002panwar@gmail.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #429 +/- ##
=======================================
Coverage 85.23% 85.23%
=======================================
Files 59 59
Lines 6934 6934
=======================================
Hits 5910 5910
Misses 1024 1024 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Address issue #84
Description
This PR sets up docstub for arviz-plots and add type hints for forest_plot.py
Added docstub.toml for type mappings (aligned with arviz-base).
Updated ci_probs type from float, float) to array-like of shape (2,) as per recommendation.
Added the generated forest_plot.pyi stub file.
Actually, I noticed some curly quotes were causing parsing issues for docstub, so I replaced them with straight quotes. Could you please let me know if this is required or if I should change it back ?
For verification I created a file and confirmed that the IDE autocomplete/hover functionality works correctly with the new stub. Please have a look in the screenshot.
closes #84